﻿/* Copyright 2008 dnAnalytics Project.
 *
 * Contributors to this file:
 * Marcus Cuda
 *
 * This file is part of dnAnalytics.  dnAnalytics is licensed under the 
 * Microsoft Public License. See License.txt for a complete copy of the
 * license.
 */
using System;
using System.Collections.Generic;

namespace dnAnalytics.LinearAlgebra.IO
{
    /// <summary>
    /// Interface to write a <see cref="Matrix"/> to a file or stream.
    /// </summary>
    public interface IMatrixWriter
    {
        /// <summary>
        /// Writes the given <see cref="Matrix"/> to the file.
        /// </summary>
        /// <param name="matrix">The matrix to write.</param>
        /// <param name="name">The name of the matrix to store in the file.</param>
        /// <exception cref="ArgumentNullException">If either <paramref name="matrix"/> or <paramref name="name"/> is null.</exception>
        void WriteMatrix(Matrix matrix, string name);

        /// <summary>
        /// Writes the given <see cref="Matrix"/> to the file. 
        /// </summary>
        /// <param name="matrices">The matrices to write.</param>
        /// <param name="names">The names of the matrices to store in the file.</param>
        /// <exception cref="ArgumentNullException">If either <paramref name="matrices"/> or <paramref name="names"/> is null.</exception>
        void WriteMatrices(IList<Matrix> matrices, IList<string> names);
    }
}